Tarefa: SI Criar a Documentação do Usuário
Criar a Documentação do Usuário do Software ou atualizar o existente, se apropriado
Disciplinas: 5 Atividade Integração e Testes de Software
Relacionamentos
FunçõesExecutor Primário: Executores Adicionais:
EntradasObrigatório:
    Opcional:
    • Nenhum
    Saídas
      Etapas
      Passo 1: Identique os documentos

      É necessário identificar que documentos serão produzidos, quando serão produzidos, por quem serão produzidos e quem são os interessados nestes documentos.

      Passo 2: Desenvolva a documentação

      Deve-se desenvolver a documentação para o usuário final, de acordo com padrões. A satisfação deste resultado implica na produção de um pacote de dados técnico que descreva o produto, de uma forma que permita às diferentes pessoas que trabalharão realizarem suas tarefas de desenvolvimento ou de manutenção.

      Passo 3: Mantenha a documentação

      Certique-se de manter e revisar a documentação necessária para a manutenção, operação e instalação do produto, de acordo com critérios previamente definidos, para garantir a consistência em relação aos requisitos e ao projeto (design). Padrões podem facilitar o entendimento e a leitura da documentação. Alguns exemplos de possíveis padrões são:

      • Fontes a serem utilizadas, dependendo do contexto (rodapé, título, conteúdo etc.);
      • Uso de abreviações;
      • Tamanho das fontes;
      • Compatibilidade com processadores de texto;
      • Imagens geralmente utilizadas pela organização na documentação.

      Os critérios incluem, por exemplo, como a documentação será mantida no sentido de controlar as suas modificações durante o projeto, mantendo-a consistente com os demais artefatos gerados durante o projeto, ou então se a documentação será desenvolvida aos poucos,durante as atividades do projeto, ou se será desenvolvida toda de uma vez só, no final do projeto. Estes critérios também podem indicar como a  documentação  estará  organizada  e  que  itens/requisitos do  sistema  deverá descrever